home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 101-125 / scopedisk103 / fishtank / docs / read.me < prev    next >
Text File  |  1995-03-19  |  18KB  |  465 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                              How to use "fishTank"
  8.  
  9.                                * fishTank.doc *
  10.                                --************--
  11.        
  12.        
  13.             This document explains how to  use  the  fishTank program to
  14.        simulate an aquarium.  Additional  instructions  on how to expand
  15.        the program's capabilities  can  be  found  in "makeFish.doc" and
  16.        "makeTanks.doc".
  17.        
  18.        
  19.                               * about fishTank *
  20.                               --**************--
  21.        
  22.        
  23.             "FishTank" is a program that  simulates  an aquarium. It was
  24.        written entirely  in  object-oriented  JForth  (version 2.0). The
  25.        intent of the program  is  to  provide  a  visually  pleasing and
  26.        relatively  accurate  simulation  of  tropical  fish  in  a  home
  27.        aquarium. While the behavior of  tropical  fish is very much more
  28.        complex than the behavior  displayed  by my simulated fish, their
  29.        survival characteristics are at  least  similar. "FishTank" could
  30.        be used as a humane way of  testing  out  various combinations of
  31.        fish and water conditions by those  planning (or just daydreaming
  32.        about) a real aquarium.
  33.           This program makes  extensive  use  of  the  Amiga's animation
  34.        system. The screen is a double-buffered  HAM-mode screen, and the
  35.        fish are  all  "AnimObs".  Although  I  probably  do  not use the
  36.        AnimObs to their fullest  advantage,  they  do work in a reliable
  37.        and consistent manner.
  38.        
  39.        
  40.                                 * setting up *
  41.                                 --**********--
  42.        
  43.        
  44.             Before you do anything else,  you  will need to "de-arc" the
  45.        program and all it's files.  I  will  assume  that  you have used
  46.        "zoo" on the archive  already  (after  all  you're  reading this,
  47.        aren't you ?), but  you  may  have  to  repeat  this step because
  48.        "fishTank" uses a directory structure that needs to be duplicated
  49.        exactly as it was when I zoo'ed  the  files  together. This means
  50.        you will have to use zoo with the "//" option. Try this:
  51.                  zoo x// fishTank.zoo
  52.             Read the documentation that comes  with zoo if you need help
  53.        with this.
  54.        
  55.        *** IMPORTANT  ***  You  will  have  to  name  the  disk that the
  56.        fishTank files are  on  "fish"  or  it  will  not run. If you are
  57.        installing fishTank on  a  hard  disk  you  will  have to "assign
  58.        fish:" to the partition and directory that you put fishTank on.
  59.  
  60.                                     Page 1
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.                              How to use "fishTank"
  74.  
  75.        
  76.             You can make as many copies of  "fishTank"  as you want, and
  77.        give them away to anybody you  choose  to,  by any means you have
  78.        available to you,  but  please  remember  to  keep  all the files
  79.        together (that includes this  "read.me"  file,  and all the other
  80.        documentation files), and  to  name  the  copies  "fish". You are
  81.        expressly forbidden to sell  or  otherwise  make  money from this
  82.        program.
  83.        
  84.            I am also requesting that  you  complete  the questionnaire I
  85.        have included with  this  program  (it's  called "write.me"), and
  86.        send it back to me either  by  ordinary  (paper  in  an envelope)
  87.        mail, or by CompuServe. You can  find  my  address and CompuServe
  88.        user ID number at the end of this document. This should only take
  89.        a few minutes of your time, and I really would appreciate it very
  90.        much.
  91.        
  92.        
  93.             "FishTank" requires an Amiga  (1000,  500, 2000, 2500 ,etc.)
  94.        with Workbench 1.2 or 1.3 and one megabyte of memory. This is not
  95.        to say that the program may not run  on systems with less memory,
  96.        however, I have experienced some problems running it in 512k, and
  97.        have not tested it on systems with between 512k and one megabyte.
  98.        I would recommend not multi-tasking fishTank with other programs 
  99.        that are graphics-  or  sound-intensive  or  otherwise  use large
  100.        amounts of chip memory.
  101.        
  102.             You will need  the  ARP  library,  version  1.3  to run this
  103.        program. It is easy to install  in  your  "libs" directory and is
  104.        available anywhere you find public-domain Amiga software.
  105.        
  106.             You should also make sure you have  the correct font for the
  107.        menus I use. If you have "Times  15"  on  your Workbench you need
  108.        not worry about doing this. If not, and if you have Workbench1.3,
  109.        you will find this  font  on  your  "Extras"  disk,  so  type the
  110.        following line in from your CLI or Shell:
  111.                        ASSIGN fonts: "Extras 1.3:fonts"
  112.        This will tell the  system  to  look  for  all  the  fonts on the
  113.        "Extras 1.3:" disk in its  "fonts"  directory. If you want to run
  114.        another program that uses Workbench fonts after you are done with
  115.        the fishTank you will need to type the following:
  116.                             ASSIGN fonts: sys:fonts
  117.        This will get you back to the fonts on your Workbench disk.
  118.             Don't be too upset if you don't have have this font or can't
  119.        find a copy of it. The fishTank  will  still run normally without
  120.        it, its menus will just not be as good looking.
  121.        
  122.        
  123.             Now that you  have  a  disk  called  "fish:"  with  all  the
  124.        fishTank  files  on  it,  you  can  run  the  program  by  either
  125.  
  126.                                     Page 2
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.                              How to use "fishTank"
  140.  
  141.        double-clicking on the "goFish"  icon,  or typing "run goFish" in
  142.        your CLI or Shell. I would  recommend copying the program and all
  143.        its  files  to  a  floppy-sized  "rad:"  disk  if  you  have  one
  144.        available, as this will make the fishTank load much faster.
  145.        
  146.             You should  now  be  looking  at  a  screen  with  the  word
  147.        "LOADING" written at  the  top.  Depending  on  weather  you  are
  148.        working from a floppy or a ram disk, you could be looking at this
  149.        for a while. You won't be able to 'drag' this screen, and I would
  150.        strongly recommend not doing  anything  else  on your Amiga until
  151.        this screen goes away.
  152.             Once the program is done  loading,  you  will see three fish
  153.        swimming around in an empty fishtank,  with  some numbers written
  154.        on the title bar. If you press  the  right  mouse button you will
  155.        see the menus. I will now  explain  the menus and menu selections
  156.        in the order in which they appear.
  157.        
  158.        
  159.                                     SYSTEM
  160.                               ------------------
  161.             The  system  menu  contains  items   that  affect  the  tank
  162.        conditions, give general  information,  or  stop the program. The
  163.        items in this menu are as follow:
  164.        
  165.                  Temperature
  166.                ---------------
  167.                  This allows you to change the water  temperature of the
  168.        fishTank. When you select this option  a requester will appear in
  169.        the fishtank. Click on the long, black rectangle at the bottom of
  170.        the requester and a  blue  button  will  appear.  Move the button
  171.        around by either clicking on the  rectangle  in the direction you
  172.        want the temperature to change,  or  click  on  the button itself
  173.        and drag it around in the rectangle. Once  you have the button in
  174.        the position you want it in,  click  on the word "Update". If you
  175.        want the temperature to  go  back  to  what it was before you saw
  176.        this requester, click on the  word  "Cancel". Most of the fish in
  177.        this tank like the  temperature  to  be  about 26 degrees Celsius
  178.        (which is about 79 degrees Fahrenheit).  If the fish that were in
  179.        the  tank  before  you  changed  the  temperature  have  suddenly
  180.        disappeared, it means that the  change  in temperature has killed
  181.        them. Check the "fishes" menu  to  see  which fish you can put in
  182.        the tank now.
  183.        
  184.                  pH
  185.                ------
  186.                  This lets you change  the  acidity  of  the  water. The
  187.        requester works in much  the  same  manner  as  the "temperature"
  188.        requester. Most fish like the pH to be pretty close to 7.0, but I
  189.        have included fish that will thrive in more acidic water (a lower
  190.        pH), and more alkaline water (a higher pH).
  191.  
  192.                                     Page 3
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.                              How to use "fishTank"
  206.  
  207.        
  208.                  Hardness
  209.                ------------
  210.                  The hardness option  lets  you  change  the  amount  of
  211.        dissolved calcium  in  the  water.  Most  water has at least some
  212.        calcium in it. A hardness of  about  200 ppm will support most of
  213.        the fish I've included.
  214.        
  215.                  About
  216.                ---------
  217.                  This selection will tell you my  name  and  address. If
  218.        you have any questions, comments,  or are interested in my source
  219.        code, you can write to me at the address on this requester. Click
  220.        on "Resume" to get rid of this requester.
  221.        
  222.                  Bibliography
  223.                ----------------
  224.                  If you select this you  will  see  the  name  of a book
  225.        about fish that I used as reference when writing this program. If
  226.        you click on "next", the name of another book will appear. If you
  227.        get tired of reading these  entries  click on "resume" to go back
  228.        to your fish.
  229.        
  230.                  Load Tank
  231.                -------------
  232.                  This selection will let you  load  a  new tank into the
  233.        background. It is mainly for  use  with tanks that you have drawn
  234.        yourself. For more about this  read  "makeTanks.doc".  It is very
  235.        important that the file you select  from this file requester is a
  236.        320 by 200 HAM-mode IFF-picture file. Don't select any files that
  237.        you are not sure of with this requester.
  238.        
  239.                  Load Fish
  240.                -------------
  241.                  You can use this menu selection to  load in a fish that
  242.        you have drawn yourself. If the water  conditions are not correct
  243.        for this fish it will still be  added  to  the "fishes" menu. See
  244.        "makeFish.doc" for complete details  on making  your own fish. It
  245.        is absolutely vital that any file you select with the "load fish"
  246.        file requester is a genuine  ".ascii"  fish  file (one that meets
  247.        all the specifications listed  in  "makeFish.doc"). If you try to
  248.        load any other type of file with this requester the fishTank will
  249.        "hang-up", causing you to have  to  reboot your machine. Once you
  250.        have 20 fish on the  "fishes"  menu  this  menu selection will be
  251.        "ghosted", and you will not be able to select it again.
  252.        
  253.                  Quit
  254.                --------
  255.                  If you chose this the fishTank will go away.
  256.        
  257.  
  258.                                     Page 4
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.                              How to use "fishTank"
  272.  
  273.        
  274.                                     FISHES
  275.                               ------------------
  276.        
  277.                 The "fishes" menu contains the  names  of all the fishes
  278.        that are currently available to fishTank.  Some of the fishes may
  279.        be "ghosted" on this menu. This  means  that the water conditions
  280.        are not conducive to the survival of this fish. If you change the
  281.        water conditions maybe you  will then  be able  to load this fish
  282.        into your tank.
  283.                  If a fish's name has a big red  dot  to the left of it,
  284.        it means that this fish is in  the  tank  right now. To put a new
  285.        fish in the tank, all you need to  do is move the cursor over its
  286.        name on the menu. To remove a  fish  from the tank, just select a
  287.        fish whose name has a dot next to it.
  288.                  If you load your own fish  (by  selecting  "Load  Fish"
  289.        from the "system" menu) its name will appear on this menu.
  290.        
  291.                  When you start up the fishTank, the following fish will
  292.        be on the "fishes" menu:
  293.                            platy
  294.                            zebra
  295.                            tetra
  296.                            discus
  297.                            snail
  298.                            barb
  299.                            oscar
  300.                            goldfish
  301.                            catfish
  302.        
  303.        
  304.                                      TANK
  305.                               ------------------
  306.        
  307.                  The tank menu will let you change the appearance of the
  308.        tank. Not only will this make  the  background look different but
  309.        it may affect the behavior of the fish. The "checked" item is the
  310.        one which is currently selected. If you have loaded your own tank
  311.        (with "Load Tank" from the  "system"  menu), the dot will be next
  312.        to the selection that best describes your tank.
  313.                  Tank menu selections are:
  314.                            gravel only
  315.                            densely planted
  316.                            rocks, plants & driftwood
  317.                            rocks, no plants
  318.        
  319.        
  320.                                      FOOD
  321.                               ------------------
  322.        
  323.  
  324.                                     Page 5
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.                              How to use "fishTank"
  338.  
  339.                  The "food" menu lets you select  the  type of food your
  340.        fish will receive. Different  fish  eat  different things, and if
  341.        you don't feed a  fish  something  that  it will eat it will die.
  342.        These are your choices:
  343.                            flakes
  344.                          ----------
  345.                            "Flakes"  basically  refers   to   any   dry,
  346.        prepared food you  would  give  to  a  fish.  Most  fish will eat
  347.        flakes. As a  general  rule  feeding  your  fish  both  worms and
  348.        vegetables is nutritionally equivalent to feeding them flakes.
  349.                            worms
  350.                          ---------
  351.                            The "worms" selection lets you feed your fish
  352.        small living creatures. Most  commonly  this  would mean worms or
  353.        brine shrimp. Feeding worms  is  a  good  idea  for fish that you
  354.        suspect are carnivorous.
  355.                            vegetables
  356.                          --------------
  357.                            Some fish are herbivorous, and  feeding  them
  358.        vegetables will make them happy (or at least well-fed).
  359.                            guppies
  360.                          -----------
  361.                            "Guppies" refers to  any  small,  inexpensive
  362.        fish that you might  want  to  feed  to  your  fish. The thing to
  363.        remember here is that a fish  that  normally  feeds on other fish
  364.        cannot distinguish between the fish you put in the tank for it to
  365.        eat and the fish that you put in the  tank that you don't want it
  366.        to eat.
  367.        
  368.        
  369.                               * acknowledgments *
  370.                               --***************--
  371.        
  372.        
  373.            Source code is available upon request, and requires JForth2.0
  374.        (which  is  available  from  Delta   Research).  The  code  makes
  375.        extensive use  of  JForth's  "ODE"  (Object-oriented  Development
  376.        Environment). I fear it may be  of  little  use to people who are
  377.        unfamiliar  with  either  forth  or  object-oriented  programming
  378.        techniques.
  379.             Before I forget, I would  like  to  thank  John Friedman for
  380.        helping  me  on   this   project   and   getting  me  started  in
  381.        object-oriented  programming.  Without  his  help  and  support I
  382.        probably never would have finished  "fishTank". I would also like
  383.        to thank Tom DeFanti,  Dan  Sandin,  and  Maxine  Brown for their
  384.        advice and for being so supportive of my ideas. I'd like to thank
  385.        Irv Moy for the use of his Amiga 500 which convinced me that this
  386.        program would run on systems other  than my old 1000. I know this
  387.        list is getting long, but I would also like to thank the folks at
  388.        Delta Research for a very well thought out language, and all that
  389.  
  390.                                     Page 6
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.                              How to use "fishTank"
  404.  
  405.        crisp, clear source code that  showed  me how the language really
  406.        works, and I would  like  to  thank  all  the  helpful  people on
  407.        CompuServe's AmigaTech forum for helping me get the information I
  408.        needed to use the ARP fileRequester.
  409.        
  410.        
  411.        You can write to me at:
  412.                                  Harriet Lurie
  413.                        Department of Art (Mail Code 036)
  414.                        University of Illinois at Chicago
  415.                                    Box 4348
  416.                                Chicago, IL 60680
  417.                                     U.S.A.
  418.        
  419.        or on CompuServe:
  420.                                  Harriet Lurie
  421.                                   73760,3624
  422.        
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.                                     Page 7
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.